home *** CD-ROM | disk | FTP | other *** search
/ C/C++ 3D Game Tools / C-C++ 3D Game Tools.iso / tools / ackkit.lzh / ack3d.txt < prev    next >
Text File  |  1993-06-20  |  11KB  |  295 lines
  1.                   ACK-3D
  2.              ( Animation Construction Kit 3-D )
  3.  
  4.  
  5. Introduction:
  6.  
  7.     Welcome to ACK3D! This contruction kit is part of a project created to
  8. allow you, the user, to design your own 3D games and applications. While
  9. still in its infancy the hope is to present enough of a kit to give you the
  10. idea of what is still to come. With ACK3D you can create your own maps and
  11. link them together together to form a 3D world of adventure. A variety of
  12. objects can populate this world, both stationary and moving, to add realism
  13. to the environment.
  14.  
  15.     Please feel free to experiment with the sample files provided, they are
  16. included for your enjoyment. Any comments regarding the kit will be greatly
  17. appreciated. Address your comments to:
  18.  
  19.     Lary Myers
  20.     76004,1574 (CompuServe account)
  21.     5 Jacob street
  22.     Ballston Lake, NY 12019
  23.  
  24.  
  25.     The Game Design library of the Gamers forum is a good place to check on
  26. CompuServe for latest versions, discussions, etc.
  27.  
  28.  
  29.                 Disclaimer
  30.  
  31.      The author, Lary Myers, and any other persons referred to
  32. in this documentation or in the computer programs ACK3D and MAPEDIT
  33. accept no responsibility for any loss of time, money or productivity,
  34. or damage to any person(s) or computer hardware or software, as a
  35. result of using the programs ACK3D and MAPEDIT, even if the above
  36. mentioned had knowledge or had been notified of the possibilities
  37. of such events.
  38.  
  39.  
  40.                 Distribution
  41.  
  42.      The programs ACK3D and MAPEDIT along with any associated files, are
  43. being released into the public domain as "PUBLICWARE" and may be freely
  44. copied and modified providing the disclaimer mentioned above is maintained
  45. in effect for any released versions.
  46.  
  47.  
  48. ------------------------------------------------------------------------------
  49. The Master Description file:
  50.  
  51.     This is the master file read into ACK3D at startup. It contains information
  52. used to create the map and images. Both ACK3D and MAPEDIT use this file.
  53.  
  54.     Naming convention;
  55.  
  56.     ACK3D will first look for the file called ACK3D.L01 to load. This is
  57.     always the level one starting place for the program. Levels are named
  58.     starting with ACK3D as the filename and L## as the extent where ## is a
  59.     two digit number for the level (ie L01, L02, ... L99). Thus, 99 levels
  60.     are possible with this naming convention.
  61.  
  62.     Comments;
  63.  
  64.     A semi-colon (;) as the first character of a line indicates a comment.
  65.  
  66.  
  67.     Commands;
  68.     The following sections are available;
  69.  
  70.  
  71. Walls:
  72.        - Begins the section that list all of the wall bitmaps used in the map.
  73.      Start with a Files: command then list the walls with the syntax,
  74.         #,wallfile[.ext]
  75.      If no extent is given then .IMG is assumed. If the extent is .BBM then
  76.      a Deluxe Paint II brush is loaded, all other extents load in the
  77.      original IMG format.
  78.      The following wall numbers are special,
  79.         58 - Secret door (either X or Y).
  80.         60 - Door on a vertical (X) wall.
  81.         61 - Side panel for doors.
  82.         62 - Door on a horizontal (Y) wall.
  83.      End the files section with EndFiles:
  84.      End the Walls section with EndWalls: (This will allow other info to
  85.         be placed in here besides walls).
  86.  
  87. Objects:
  88.        - Begin the files section with the Files: command then list objects with
  89.      the same syntax as the Walls ( #,objectfile[.ext] )
  90.      End the files section with a EndFiles: command.
  91.      Next comes the object description section, the following commands apply
  92.      to every object,
  93.  
  94.      Number: Object number from 1 to 100 identifying the object
  95.  
  96.      Bitmaps: Numbers from the object files section identifying which
  97.           bitmaps to display for this object. A single number here says
  98.           the object has only 1 bitmap to display. Multiple numbers
  99.           separated by commas indicate the object has multiple views
  100.           or bitmaps.
  101.  
  102.      Direction: Number from 0 to 10 where 0-7 are movement directions using,
  103.  
  104.             7    0   1
  105.               \ | /
  106.             6 - + - 2
  107.               / | \
  108.             5    4   3
  109.  
  110.             Direction 8 is move up, 9 is move down, and 10 is stay
  111.             in one place and cycle through the multiple views. This
  112.             will allow objects to animate in one place.
  113.  
  114.      Speed: Number from 0 to 255 (Higher than 48 seems to be way too fast
  115.         and may not be reliable yet). A value of 0 means the object
  116.         is stationary.
  117.  
  118.  
  119.  
  120.      Continue listing objects with the above commands.
  121.      End the objects section with the EndObjects: command.
  122.  
  123.  
  124. StartX:
  125.        - Initial X coordinate of player. Should be greater than 64 (since the
  126.      map needs walls all around its borders) and less than 4032.
  127.  
  128. StartY:
  129.        - Initial Y coordinate of player, from 65 to 4031.
  130.  
  131.  
  132. StartAngle:
  133.        - Initial angle player is facing. For now this number is based on a
  134.      circle that is 1920 units around, so...
  135.  
  136.  
  137.               (270 deg)
  138.        (225 deg) 1200  1440 1680 (315 deg)
  139.               \ | /
  140.     (180 deg) 960 - + - 0 (0 or 360 deg)
  141.               / | \
  142.     (135 deg) 720  480  240 (45 deg)
  143.               (90 deg)
  144.  
  145.  
  146. SkyColor:
  147.       - Color from 0 to 255 to use on the top half of screen
  148.  
  149. FloorColor:
  150.       - Color from 0 to 255 to use on the bottom half of screen
  151.  
  152. FlashColor:
  153.       - Color from 0 to 255 to use with random lightning flashes
  154.  
  155. DoorSpeed:
  156.       - Number from 1 to 255 to use when opening the door, 2 is the
  157.     default, 4 seems to work pretty well.
  158.  
  159. MapFile:
  160.       - Filename of map to load (default is xgrid.dat)
  161.  
  162. PalFile:
  163.       - Filename of palette file to load
  164.  
  165. GoalScreen:
  166.       - Filename of screen to load when goal is reached. (May be either an
  167.     IMG file or a LBM Deluxe Paint file).
  168.  
  169. GoalPal:
  170.       - Filename of palette file to load when goal reached. Only needed if
  171.     an IMG screen is used (LBM files have embedded palettes).
  172.  
  173. ------------------------------------------------------------------------------
  174. Controls when running ACK3D:
  175.  
  176.     Use the mouse or keyboard arrows to move around the map. When coming upon
  177. a door, click the right button of the mouse to open it (it will close by
  178. itself after a brief interval).
  179.  
  180.     Use ESCAPE to exit ACK3D.
  181.  
  182. ------------------------------------------------------------------------------
  183. Map Editor:
  184.  
  185.     The mapedit program supplied (don't laugh, it was a quick and dirty program
  186. to avoid using a hex editor to edit the maps!) allows the MapFile to be edited
  187. for use with ACK3D. To use type MAPEDIT followed by the name of the description
  188. file (NOT THE MAP FILE!). MapEdit will use the information in the description
  189. file to load the object bitmaps and the map codes.
  190.  
  191.     A mouse is required to use MapEdit.
  192.  
  193.  
  194. Controls:
  195.     Use the left mouse button to select a wall or object and to place it on
  196. the map.
  197.  
  198.     Use the right mouse button to place a blank square on the map (The same as
  199.     selecting the blank square and using the left button).
  200.  
  201.     Select Exit or press ESCAPE to exit MapEdit.
  202.  
  203.  
  204. MapEdit Layout:
  205.  
  206. ╔══════════════════════════════════════════════════════════════════════════════╗
  207. ║                 ┌─┐                           ║
  208. ║                 │2│  ┌───────────────┐ ┌─┐ ┌───────────────┐  ║
  209. ║                 └─┘  │              │ │3│ │            │  ║
  210. ║ ╔════════════════════════════════╗  │              │ └─┘ │            │  ║
  211. ║ ║                   ║  │              │ ┌─┐ │            │  ║
  212. ║ ║                   ║  │              │ │4│ │            │  ║
  213. ║ ║                   ║  │              │ └─┘ │            │  ║
  214. ║ ║                   ║  │              │ ┌─┐ │            │  ║
  215. ║ ║                   ║  │         9          │ │5│ │     10        │  ║
  216. ║ ║        1           ║  │              │ └─┘ │            │  ║
  217. ║ ║                   ║  │              │ ┌─┐ │            │  ║
  218. ║ ║                   ║  │              │ │6│ │            │  ║
  219. ║ ║                   ║  │              │ └─┘ │            │  ║
  220. ║ ║                   ║  │              │ ┌─┐ │            │  ║
  221. ║ ║                   ║  │              │ │7│ │            │  ║
  222. ║ ║                   ║  │              │ └─┘ │            │  ║
  223. ║ ║                   ║  │              │ ┌─┐ │            │  ║
  224. ║ ║                   ║  │              │ │8│ │            │  ║
  225. ║ ╚════════════════════════════════╝  └───────────────┘ └─┘ └───────────────┘  ║
  226. ║                      ┌───────────────┐        ┌───────────────┐  ║
  227. ║  ┌────┐ ┌────┐ ┌───┐ ┌────┐          │              │        │            │  ║
  228. ║  │Load│ │Save│ │New│ │Exit│          │         11          │        │      12        │  ║
  229. ║  └────┘ └────┘ └───┘ └────┘          │              │        │            │  ║
  230. ║                      └───────────────┘        └───────────────┘  ║
  231. ╚══════════════════════════════════════════════════════════════════════════════╝
  232.  
  233. Areas:
  234.     1 - Map display area, use the scrollbar arrows on the sides to scroll
  235.     around the map.
  236.  
  237.     2 - Current selected wall or object.
  238.  
  239.     3 - Pass checkbox. When selected any objects placed on the map will allow
  240.     the player to walk/pass through the object. A small dot to the left
  241.     of the number in the map (area 1) will indicate the object is passable.
  242.     The pass option is good for things like lights, etc.
  243.  
  244.     4 - Blank square. This square can be selected to erase any walls or objects
  245.     on the map.
  246.  
  247.     5 - Start square. Only ONE allowed per level. When used the start square
  248.     will override the StartX and StartY commands in the master description
  249.     file (but not the StartAngle).
  250.  
  251.     6 - Up square. Causes the player to move back up one level until level one
  252.     is reached.
  253.  
  254.     7 - Down square. Causes the player to move down one level.
  255.  
  256.     8 - Goal square. Only one of these should be in the entire game. Presents
  257.     the screen specified in the master description file and then ends the
  258.     program. If no goal screen is found then a simple YOU WON is displayed.
  259.  
  260.     9 - Walls. Select the current wall to use. The bitmap will appear in area
  261.     7 when selected.
  262.  
  263.    10 - Objects. Select the current object to use. The FIRST bitmap for the
  264.     object will appear in area 8. NOTE: The object numbers in area 5 are
  265.     the identifiers that appear in the Objects: section of the description
  266.     file, NOT the bitmap numbers. Only one occurance of an object can
  267.     appear on the map. A warning box will display if the same object is
  268.     being placed more than once.
  269.  
  270.  
  271.    11 - Bitmap of current wall.
  272.  
  273.    12 - Bitmap of current object.
  274.  
  275. Buttons:
  276.     Load - Not functional yet. Will eventually allow other maps to be loaded.
  277.  
  278.     Save - Saves the current map to the MapFile specified in the description
  279.        file.
  280.  
  281.     New     - Will give a warning box and then clear the entire map to blank
  282.        squares.
  283.  
  284.     Exit - Will warn if the map has been modified and then exit to DOS.
  285.  
  286.  
  287. Colors:
  288.     MapEdit has a pretty dull screen. This was done so that the actual bitmaps
  289. and palette file could be loaded and viewed while still allowing the user to
  290. see the edit screen. In order to do this the colors 0,11, and 15 are forced to
  291. thier default palette color by MapEdit. This may cause some of the bitmaps to
  292. show speckles of the wrong color if they happen to use any of these 3 colors.
  293.  
  294.  
  295.